home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / chpevx.z / chpevx
Text File  |  1996-03-14  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHPPPPEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCHHHHPPPPEEEEVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHPEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian matrix A in packed storage
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHPEVX( JOBZ, RANGE, UPLO, N, AP, VL, VU, IL, IU, ABSTOL, M,
  14.                         W, Z, LDZ, WORK, RWORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE, UPLO
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          REAL           RWORK( * ), W( * )
  25.  
  26.          COMPLEX        AP( * ), WORK( * ), Z( LDZ, * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      CHPEVX computes selected eigenvalues and, optionally, eigenvectors of a
  30.      complex Hermitian matrix A in packed storage.  Eigenvalues/vectors can be
  31.      selected by specifying either a range of values or a range of indices for
  32.      the desired eigenvalues.
  33.  
  34.  
  35. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  36.      JOBZ    (input) CHARACTER*1
  37.              = 'N':  Compute eigenvalues only;
  38.              = 'V':  Compute eigenvalues and eigenvectors.
  39.  
  40.      RANGE   (input) CHARACTER*1
  41.              = 'A': all eigenvalues will be found;
  42.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  43.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  44.  
  45.      UPLO    (input) CHARACTER*1
  46.              = 'U':  Upper triangle of A is stored;
  47.              = 'L':  Lower triangle of A is stored.
  48.  
  49.      N       (input) INTEGER
  50.              The order of the matrix A.  N >= 0.
  51.  
  52.      AP      (input/output) COMPLEX array, dimension (N*(N+1)/2)
  53.              On entry, the upper or lower triangle of the Hermitian matrix A,
  54.              packed columnwise in a linear array.  The j-th column of A is
  55.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  56.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  57.              j)/2) = A(i,j) for j<=i<=n.
  58.  
  59.              On exit, AP is overwritten by values generated during the
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHPPPPEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCHHHHPPPPEEEEVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.              reduction to tridiagonal form.  If UPLO = 'U', the diagonal and
  75.              first superdiagonal of the tridiagonal matrix T overwrite the
  76.              corresponding elements of A, and if UPLO = 'L', the diagonal and
  77.              first subdiagonal of T overwrite the corresponding elements of A.
  78.  
  79.      VL      (input) REAL
  80.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  81.              the interval to be searched for eigenvalues. VL < VU.  Not
  82.              referenced if RANGE = 'A' or 'I'.
  83.  
  84.      IL      (input) INTEGER
  85.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  86.              order) of the smallest and largest eigenvalues to be returned.  1
  87.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  88.              referenced if RANGE = 'A' or 'V'.
  89.  
  90.      ABSTOL  (input) REAL
  91.              The absolute error tolerance for the eigenvalues.  An approximate
  92.              eigenvalue is accepted as converged when it is determined to lie
  93.              in an interval [a,b] of width less than or equal to
  94.  
  95.              ABSTOL + EPS *   max( |a|,|b| ) ,
  96.  
  97.              where EPS is the machine precision.  If ABSTOL is less than or
  98.              equal to zero, then  EPS*|T|  will be used in its place, where
  99.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  100.              AP to tridiagonal form.
  101.  
  102.              Eigenvalues will be computed most accurately when ABSTOL is set
  103.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  104.              this routine returns with INFO>0, indicating that some
  105.              eigenvectors did not converge, try setting ABSTOL to
  106.              2*SLAMCH('S').
  107.  
  108.              See "Computing Small Singular Values of Bidiagonal Matrices with
  109.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  110.              Working Note #3.
  111.  
  112.      M       (output) INTEGER
  113.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  114.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  115.  
  116.      W       (output) REAL array, dimension (N)
  117.              If INFO = 0, the selected eigenvalues in ascending order.
  118.  
  119.      Z       (output) COMPLEX array, dimension (LDZ, max(1,M))
  120.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  121.              the orthonormal eigenvectors of the matrix A corresponding to the
  122.              selected eigenvalues, with the i-th column of Z holding the
  123.              eigenvector associated with W(i).  If an eigenvector fails to
  124.              converge, then that column of Z contains the latest approximation
  125.              to the eigenvector, and the index of the eigenvector is returned
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHPPPPEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCHHHHPPPPEEEEVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  141.              user must ensure that at least max(1,M) columns are supplied in
  142.              the array Z; if RANGE = 'V', the exact value of M is not known in
  143.              advance and an upper bound must be used.
  144.  
  145.      LDZ     (input) INTEGER
  146.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  147.              'V', LDZ >= max(1,N).
  148.  
  149.      WORK    (workspace) COMPLEX array, dimension (2*N)
  150.  
  151.      RWORK   (workspace) REAL array, dimension (7*N)
  152.  
  153.      IWORK   (workspace) INTEGER array, dimension (5*N)
  154.  
  155.      IFAIL   (output) INTEGER array, dimension (N)
  156.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  157.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  158.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  159.              is not referenced.
  160.  
  161.      INFO    (output) INTEGER
  162.              = 0:  successful exit
  163.              < 0:  if INFO = -i, the i-th argument had an illegal value
  164.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  165.              indices are stored in array IFAIL.
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.